GH-537: [Release][Docs] Generate API reference #538
Conversation
The followings are out-of-scope: * Generate Sphinx based documents * Publish this to https://arrow.apache.org/java/reference/ in release process * Publish this to https://arrow.apache.org/dev/reference/ nightly
There was a problem hiding this comment.
Does this build the docs for the JNI components too? Or do we need to enable the JNI build to get the Javadocs?
There was a problem hiding this comment.
Does this build the docs for the JNI components too?
No.
Or do we need to enable the JNI build to get the Javadocs?
Yes. But it's easy because we already have JNI enabled jobs. I'll do it.
There was a problem hiding this comment.
I thought we can use docker compose run vcpkg-jni but it doesn't create JAR. So I can't use it for mvn site.
I used ci/scripts/jni_full_build.sh instead.
There was a problem hiding this comment.
Ah, yes, vcpkg-jni only builds the shared object and not the full package
| # TODO: ARROW_JAVA_SHADE_FLATBUFFERS isn't used for our artifacts. Do | ||
| # we need this? | ||
| # See also: https://github.com/apache/arrow/issues/22021 | ||
| if [ "${ARROW_JAVA_SHADE_FLATBUFFERS:-OFF}" == "ON" ]; then |
There was a problem hiding this comment.
I think we need to revisit this sometime because of #67 (and it appears Google has closed the issue asking them to fix it upstream).
AFAIK the discussion in the issue you found is weird...We shouldn't need to change imports ourselves, the shading should take care of that. But that's not relevant here.
There was a problem hiding this comment.
OK. Can we use #67 for this topic? Or should we create a separated issue for this topic?
|
BTW, I will try to migrate the Sphinx docs when I get a chance |
|
I confirmed that |
2 participants
The followings are out-of-scope: